GetOrderableDynamicPartitions Method

Task Parallel System.Threading

Creates an object that can partition the underlying collection into a variable number of partitions.

Namespace:  System.Collections.Concurrent
Assembly:  System.Threading (in System.Threading.dll)

Syntax

Visual Basic (Declaration)
Public Overridable Function GetOrderableDynamicPartitions As IEnumerable(Of KeyValuePair(Of Long, TSource))
C#
public virtual IEnumerable<KeyValuePair<long, TSource>> GetOrderableDynamicPartitions()

Return Value

An object that can create partitions over the underlying data source.

Remarks

The returned object implements the IEnumerable<(Of <(TSource>)>) interface. Calling GetEnumerator on the object creates another partition over the sequence.

Each partition is represented as an enumerator over key-value pairs. The value in the pair is the element itself, and the key is an integer which determines the relative ordering of this element against other elements.

The GetOrderableDynamicPartitions()()() method is only supported if the SupportsDynamicPartitions property returns true.

Exceptions

ExceptionCondition
System..::.NotSupportedExceptionDynamic partitioning is not supported by this partitioner.

See Also